<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: EnumComboBox.html 795 2013-12-11 18:48:15Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.vaadin;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import com.vaadin.ui.AbstractSelect;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import com.vaadin.ui.ComboBox;<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span>/**<a name="line.13"></a>
<span class="sourceLineNo">014</span> * {@link ComboBox} that chooses an {@link Enum} value.<a name="line.14"></a>
<span class="sourceLineNo">015</span> *<a name="line.15"></a>
<span class="sourceLineNo">016</span> * @see EnumContainer<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>@SuppressWarnings("serial")<a name="line.18"></a>
<span class="sourceLineNo">019</span>public class EnumComboBox extends ComboBox {<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>    /**<a name="line.21"></a>
<span class="sourceLineNo">022</span>     * Default constructor.<a name="line.22"></a>
<span class="sourceLineNo">023</span>     *<a name="line.23"></a>
<span class="sourceLineNo">024</span>     * &lt;p&gt;<a name="line.24"></a>
<span class="sourceLineNo">025</span>     * Caller must separately invoke {@link #setEnumDataSource}.<a name="line.25"></a>
<span class="sourceLineNo">026</span>     * &lt;/p&gt;<a name="line.26"></a>
<span class="sourceLineNo">027</span>     */<a name="line.27"></a>
<span class="sourceLineNo">028</span>    public EnumComboBox() {<a name="line.28"></a>
<span class="sourceLineNo">029</span>        this(null);<a name="line.29"></a>
<span class="sourceLineNo">030</span>    }<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>    /**<a name="line.32"></a>
<span class="sourceLineNo">033</span>     * Convenience constructor.<a name="line.33"></a>
<span class="sourceLineNo">034</span>     *<a name="line.34"></a>
<span class="sourceLineNo">035</span>     * &lt;p&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span>     * Equivalent to:<a name="line.36"></a>
<span class="sourceLineNo">037</span>     *  &lt;blockquote&gt;&lt;code&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span>     *  EnumComboBox(enumClass, EnumContainer.TO_STRING_PROPERTY.getName(), false);<a name="line.38"></a>
<span class="sourceLineNo">039</span>     *  &lt;/code&gt;&lt;/blockquote&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * &lt;/p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span>     *<a name="line.41"></a>
<span class="sourceLineNo">042</span>     * @param enumClass enum type, or null to leave data source unset<a name="line.42"></a>
<span class="sourceLineNo">043</span>     */<a name="line.43"></a>
<span class="sourceLineNo">044</span>    public &lt;T extends Enum&lt;T&gt;&gt; EnumComboBox(Class&lt;T&gt; enumClass) {<a name="line.44"></a>
<span class="sourceLineNo">045</span>        this(enumClass, false);<a name="line.45"></a>
<span class="sourceLineNo">046</span>    }<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span>    /**<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * Convenience constructor.<a name="line.49"></a>
<span class="sourceLineNo">050</span>     *<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * &lt;p&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span>     * Equivalent to:<a name="line.52"></a>
<span class="sourceLineNo">053</span>     *  &lt;blockquote&gt;&lt;code&gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span>     *  EnumComboBox(enumClass, EnumContainer.TO_STRING_PROPERTY, allowNull);<a name="line.54"></a>
<span class="sourceLineNo">055</span>     *  &lt;/code&gt;&lt;/blockquote&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span>     * &lt;/p&gt;<a name="line.56"></a>
<span class="sourceLineNo">057</span>     *<a name="line.57"></a>
<span class="sourceLineNo">058</span>     * @param enumClass enum type, or null to leave data source unset<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * @param allowNull true to allow a null selection, false otherwise<a name="line.59"></a>
<span class="sourceLineNo">060</span>     */<a name="line.60"></a>
<span class="sourceLineNo">061</span>    public &lt;T extends Enum&lt;T&gt;&gt; EnumComboBox(Class&lt;T&gt; enumClass, boolean allowNull) {<a name="line.61"></a>
<span class="sourceLineNo">062</span>        this(enumClass, EnumContainer.TO_STRING_PROPERTY, allowNull);<a name="line.62"></a>
<span class="sourceLineNo">063</span>    }<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span>    /**<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * Convenience constructor.<a name="line.66"></a>
<span class="sourceLineNo">067</span>     *<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * &lt;p&gt;<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * Equivalent to:<a name="line.69"></a>
<span class="sourceLineNo">070</span>     *  &lt;blockquote&gt;&lt;code&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span>     *  EnumComboBox(enumClass, displayPropertyName, false);<a name="line.71"></a>
<span class="sourceLineNo">072</span>     *  &lt;/code&gt;&lt;/blockquote&gt;<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * &lt;/p&gt;<a name="line.73"></a>
<span class="sourceLineNo">074</span>     *<a name="line.74"></a>
<span class="sourceLineNo">075</span>     * @param enumClass enum type<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * @param displayPropertyName container property to display in the combo box<a name="line.76"></a>
<span class="sourceLineNo">077</span>     */<a name="line.77"></a>
<span class="sourceLineNo">078</span>    public &lt;T extends Enum&lt;T&gt;&gt; EnumComboBox(Class&lt;T&gt; enumClass, String displayPropertyName) {<a name="line.78"></a>
<span class="sourceLineNo">079</span>        this(enumClass, displayPropertyName, false);<a name="line.79"></a>
<span class="sourceLineNo">080</span>    }<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span>    /**<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * Convenience constructor.<a name="line.83"></a>
<span class="sourceLineNo">084</span>     *<a name="line.84"></a>
<span class="sourceLineNo">085</span>     * &lt;p&gt;<a name="line.85"></a>
<span class="sourceLineNo">086</span>     * Equivalent to:<a name="line.86"></a>
<span class="sourceLineNo">087</span>     *  &lt;blockquote&gt;&lt;code&gt;<a name="line.87"></a>
<span class="sourceLineNo">088</span>     *  EnumComboBox(enumClass != null ? new EnumContainer&amp;lt;T&amp;gt;(enumClass) : null, displayPropertyName, allowNull);<a name="line.88"></a>
<span class="sourceLineNo">089</span>     *  &lt;/code&gt;&lt;/blockquote&gt;<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * &lt;/p&gt;<a name="line.90"></a>
<span class="sourceLineNo">091</span>     *<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * @param enumClass enum type, or null to leave data source unset<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * @param displayPropertyName container property to display in the combo box<a name="line.93"></a>
<span class="sourceLineNo">094</span>     * @param allowNull true to allow a null selection, false otherwise<a name="line.94"></a>
<span class="sourceLineNo">095</span>     */<a name="line.95"></a>
<span class="sourceLineNo">096</span>    public &lt;T extends Enum&lt;T&gt;&gt; EnumComboBox(Class&lt;T&gt; enumClass, String displayPropertyName, boolean allowNull) {<a name="line.96"></a>
<span class="sourceLineNo">097</span>        this(enumClass != null ? new EnumContainer&lt;T&gt;(enumClass) : null, displayPropertyName, allowNull);<a name="line.97"></a>
<span class="sourceLineNo">098</span>    }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span>    /**<a name="line.100"></a>
<span class="sourceLineNo">101</span>     * Primary constructor.<a name="line.101"></a>
<span class="sourceLineNo">102</span>     *<a name="line.102"></a>
<span class="sourceLineNo">103</span>     * &lt;p&gt;<a name="line.103"></a>
<span class="sourceLineNo">104</span>     * This instance is configured for item caption {@link AbstractSelect#ITEM_CAPTION_MODE_PROPERTY} mode, with<a name="line.104"></a>
<span class="sourceLineNo">105</span>     * {@code displayPropertyName} as the {@linkplain #setItemCaptionPropertyId item caption property}.<a name="line.105"></a>
<span class="sourceLineNo">106</span>     * &lt;/p&gt;<a name="line.106"></a>
<span class="sourceLineNo">107</span>     *<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * @param container container data source, or null to leave data source unset<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * @param displayPropertyName container property to display in the combo box<a name="line.109"></a>
<span class="sourceLineNo">110</span>     * @param allowNull true to allow a null selection, false otherwise<a name="line.110"></a>
<span class="sourceLineNo">111</span>     */<a name="line.111"></a>
<span class="sourceLineNo">112</span>    public EnumComboBox(EnumContainer&lt;?&gt; container, String displayPropertyName, boolean allowNull) {<a name="line.112"></a>
<span class="sourceLineNo">113</span>        if (container != null)<a name="line.113"></a>
<span class="sourceLineNo">114</span>            this.setContainerDataSource(container);<a name="line.114"></a>
<span class="sourceLineNo">115</span>        this.setNewItemsAllowed(false);<a name="line.115"></a>
<span class="sourceLineNo">116</span>        this.setTextInputAllowed(false);<a name="line.116"></a>
<span class="sourceLineNo">117</span>        this.setFilteringMode(AbstractSelect.Filtering.FILTERINGMODE_OFF);<a name="line.117"></a>
<span class="sourceLineNo">118</span>        this.setItemCaptionMode(AbstractSelect.ITEM_CAPTION_MODE_PROPERTY);<a name="line.118"></a>
<span class="sourceLineNo">119</span>        this.setItemCaptionPropertyId(displayPropertyName);<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span>        // Set up whether null selection is allowed<a name="line.121"></a>
<span class="sourceLineNo">122</span>        this.setNullSelectionAllowed(allowNull);<a name="line.122"></a>
<span class="sourceLineNo">123</span>        if (!allowNull &amp;&amp; !this.getContainerDataSource().getItemIds().isEmpty())<a name="line.123"></a>
<span class="sourceLineNo">124</span>            this.setValue(this.getContainerDataSource().getItemIds().iterator().next());<a name="line.124"></a>
<span class="sourceLineNo">125</span>    }<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span>    /**<a name="line.127"></a>
<span class="sourceLineNo">128</span>     * Set the {@link Enum} type whose instances serve as this instance's data source.<a name="line.128"></a>
<span class="sourceLineNo">129</span>     *<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * @throws IllegalArgumentException if {@code enumClass} is null<a name="line.130"></a>
<span class="sourceLineNo">131</span>     */<a name="line.131"></a>
<span class="sourceLineNo">132</span>    public &lt;T extends Enum&lt;T&gt;&gt; void setEnumDataSource(Class&lt;T&gt; enumClass) {<a name="line.132"></a>
<span class="sourceLineNo">133</span>        this.setContainerDataSource(new EnumContainer&lt;T&gt;(enumClass));<a name="line.133"></a>
<span class="sourceLineNo">134</span>        if (!this.isNullSelectionAllowed() &amp;&amp; !this.getContainerDataSource().getItemIds().isEmpty())<a name="line.134"></a>
<span class="sourceLineNo">135</span>            this.setValue(this.getContainerDataSource().getItemIds().iterator().next());<a name="line.135"></a>
<span class="sourceLineNo">136</span>    }<a name="line.136"></a>
<span class="sourceLineNo">137</span>}<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>




























































</pre>
</div>
</body>
</html>
